<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kinetis Bootloader Host: blfwk::DataSource::Segment Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kinetis Bootloader Host
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   <div id="projectbrief">Host Tools for Kinetis devices</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Introduction</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classblfwk_1_1_data_source_1_1_segment.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classblfwk_1_1_data_source_1_1_segment-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">blfwk::DataSource::Segment Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div>  </div>
</div><!--header-->
<div class="contents">

<p>Discrete, contiguous part of the source's data.  
 <a href="classblfwk_1_1_data_source_1_1_segment.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="src_2blfwk_2_data_source_8h_source.html">DataSource.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Inheritance diagram for blfwk::DataSource::Segment:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classblfwk_1_1_data_source_1_1_segment__inherit__graph.svg" width="695" height="300"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-1-trigger" src="closed.png" alt="+"/> Collaboration diagram for blfwk::DataSource::Segment:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classblfwk_1_1_data_source_1_1_segment__coll__graph.svg" width="308" height="142"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0afe9c18e41b3529af0fe2d868d2b8f6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0afe9c18e41b3529af0fe2d868d2b8f6"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_source_1_1_segment.html#a0afe9c18e41b3529af0fe2d868d2b8f6">Segment</a> (<a class="el" href="classblfwk_1_1_data_source.html">DataSource</a> &amp;source)</td></tr>
<tr class="memdesc:a0afe9c18e41b3529af0fe2d868d2b8f6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Default constructor. <br /></td></tr>
<tr class="separator:a0afe9c18e41b3529af0fe2d868d2b8f6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0796a4bf08ad30c2fb61847dc2a3e90f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0796a4bf08ad30c2fb61847dc2a3e90f"></a>
virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_source_1_1_segment.html#a0796a4bf08ad30c2fb61847dc2a3e90f">~Segment</a> ()</td></tr>
<tr class="memdesc:a0796a4bf08ad30c2fb61847dc2a3e90f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:a0796a4bf08ad30c2fb61847dc2a3e90f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a518cfc843856682a550302f58f4b252c"><td class="memItemLeft" align="right" valign="top">virtual unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_source_1_1_segment.html#a518cfc843856682a550302f58f4b252c">getData</a> (unsigned offset, unsigned maxBytes, uint8_t *buffer)=0</td></tr>
<tr class="memdesc:a518cfc843856682a550302f58f4b252c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets all or a portion of the segment's data.  <a href="#a518cfc843856682a550302f58f4b252c">More...</a><br /></td></tr>
<tr class="separator:a518cfc843856682a550302f58f4b252c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa974f251e332134e73f2924560cfd5c4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa974f251e332134e73f2924560cfd5c4"></a>
virtual unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_source_1_1_segment.html#aa974f251e332134e73f2924560cfd5c4">getLength</a> ()=0</td></tr>
<tr class="memdesc:aa974f251e332134e73f2924560cfd5c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the length of the segment's data. <br /></td></tr>
<tr class="separator:aa974f251e332134e73f2924560cfd5c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a72b9a2d2824ddc9288c8f5982874fb1a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a72b9a2d2824ddc9288c8f5982874fb1a"></a>
virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_source_1_1_segment.html#a72b9a2d2824ddc9288c8f5982874fb1a">hasNaturalLocation</a> ()=0</td></tr>
<tr class="memdesc:a72b9a2d2824ddc9288c8f5982874fb1a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns whether the segment has an associated address. <br /></td></tr>
<tr class="separator:a72b9a2d2824ddc9288c8f5982874fb1a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a426897327bc9930ac7291cf7ef80be0e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a426897327bc9930ac7291cf7ef80be0e"></a>
virtual uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_source_1_1_segment.html#a426897327bc9930ac7291cf7ef80be0e">getBaseAddress</a> ()</td></tr>
<tr class="memdesc:a426897327bc9930ac7291cf7ef80be0e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the address associated with the segment. <br /></td></tr>
<tr class="separator:a426897327bc9930ac7291cf7ef80be0e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:ace39325ad306a493951b2da7064a40e7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace39325ad306a493951b2da7064a40e7"></a>
<a class="el" href="classblfwk_1_1_data_source.html">DataSource</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_data_source_1_1_segment.html#ace39325ad306a493951b2da7064a40e7">m_source</a></td></tr>
<tr class="memdesc:ace39325ad306a493951b2da7064a40e7"><td class="mdescLeft">&#160;</td><td class="mdescRight">The data source to which this segment belongs. <br /></td></tr>
<tr class="separator:ace39325ad306a493951b2da7064a40e7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Discrete, contiguous part of the source's data. </p>
<p>This class is purely abstract and subclasses of <a class="el" href="classblfwk_1_1_data_source.html" title="Abstract base class for data sources. ">DataSource</a> are expected to subclass it to implement a segment particular to their needs. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a518cfc843856682a550302f58f4b252c"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">virtual unsigned blfwk::DataSource::Segment::getData </td>
          <td>(</td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>offset</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">unsigned&#160;</td>
          <td class="paramname"><em>maxBytes</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint8_t *&#160;</td>
          <td class="paramname"><em>buffer</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Gets all or a portion of the segment's data. </p>
<p>The data is copied into <em>buffer</em>. Up to <em>maxBytes</em> bytes may be copied, so <em>buffer</em> must be at least that large.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">offset</td><td>Index of the first byte to start copying from. </td></tr>
    <tr><td class="paramname">maxBytes</td><td>The maximum number of bytes that can be returned. <em>buffer</em> must be at least this large. </td></tr>
    <tr><td class="paramname">buffer</td><td>Pointer to buffer where the data is copied. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes copied into <em>buffer</em>. </dd></dl>

<p>Implemented in <a class="el" href="classblfwk_1_1_memory_image_data_source_1_1_text_segment.html#a38fc03891c48d05098576a59d9307c82">blfwk::MemoryImageDataSource::TextSegment</a>, <a class="el" href="classblfwk_1_1_unmapped_data_source.html#abe4bd0ab24794bceab017b66bf0a08ae">blfwk::UnmappedDataSource</a>, <a class="el" href="classblfwk_1_1_e_l_f_source_file_1_1_e_l_f_data_source_1_1_prog_bits_segment.html#ab0c90050602a06674ec013d937dbe446">blfwk::ELFSourceFile::ELFDataSource::ProgBitsSegment</a>, and <a class="el" href="classblfwk_1_1_data_source_1_1_pattern_segment.html#aae3c6a62a4f69c53dcd04a5dbd120793">blfwk::DataSource::PatternSegment</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="src_2blfwk_2_data_source_8h_source.html">src/blfwk/DataSource.h</a></li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>blfwk</b></li><li class="navelem"><a class="el" href="classblfwk_1_1_data_source.html">DataSource</a></li><li class="navelem"><a class="el" href="classblfwk_1_1_data_source_1_1_segment.html">Segment</a></li>
    <li class="footer">Generated on Mon Mar 7 2016 16:49:51 for Kinetis Bootloader Host by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
